Set docstring linewidth to 75 to avoid wrapping in jupyterlab help popup#1939
Merged
nicolaskruchten merged 2 commits intoplotly:masterfrom Dec 3, 2019
Merged
Set docstring linewidth to 75 to avoid wrapping in jupyterlab help popup#1939nicolaskruchten merged 2 commits intoplotly:masterfrom
nicolaskruchten merged 2 commits intoplotly:masterfrom
Conversation
Contributor
Author
|
I should note that the pep8 recommendation for doscstrings is a line width of 72 so I can change to that if desired. I looked around briefly in the rest of the plotly code and it seems like a both 72 and 75 is used, so either should be fine for consistency within the project. I am happy with either, I just want the docstrings to fit without wrapping in the help dialog boxes. |
Contributor
|
Thanks for this! Let's stick with 75 for now unless we can easily force everything to 72 :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I noticed that I didn't cover the one line chart descriptions in #1866, so adding them in this PR.
Current:
Suggested:
When I did this I noticed that the exact line width that jupyterlab breaks at is 76, not 78, so I updated the autoformatting of the docs as well.